Health and Social Care Integration
Domain Message Specification

DischargeNoticeAgreement Tabular View

COMT_RM000006UK03
DischargeNoticeAgreement

An agree response from Social Services for a Discharge Notice.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="INFRM" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a type of act that relates to provision of information and/or understanding about a topic to a subject.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "INFRM".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an inform event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:SnomedCT } )
{ Fixed="975821000000109" }

Model Attribute Description

The HL7 attribute code uses a code from the SnomedCT vocabulary to describe that this is a Discharge Notice Agreement under the Care Act 2014 Schedule 3.

Implementation in XML Instance

The Coded with Code System flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code is fixed to "975821000000109".
  • The XML attribute codeSystem is fixed to "2.16.840.1.113883.2.1.3.2.4.15".
[1..1] [M] effectiveTime (TS)

Model Attribute Description

The HL7 attribute effectiveTime is used to define the time the Discharge Notice Agreement message was issued.

Implementation in XML Instance

The XML attribute value of the XML element effectiveTime shall be populated with the time the Discharge Notice Agreement message was created using a time stamp in the format yyyymmddhhmmss[+|-ZZzz] where:

  • yyyy is the year
  • mm is the month
  • dd is the day
  • hh is the hour
  • mm is the minute
  • ss is the seconds
  • [+|-ZZzz] is the time zone offset in hours and minutes

Sections from the right of this representation may be left off when the sending system does not record to this level of accuracy. When hours are present, the time zone offset must also be present.

[1..2] [M] id (SET<II>)
Model Attribute Description

The HL7 attribute id uses an identifier to identify the acts involved in the Delayed Discharge process, where the:

  • First mandatory id, identifies the Discharge Notice Agreement message instance.
  • The second optional id, identifies the Delayed Discharge process in which this Discharge Notice Agreement message forms part of.

Implementation in XML Instance

The first, mandatory id shall be the identifier of this Discharge Notice Agreement message instance used for transmission. The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.

The second, optional id shall be the identifier of the Delayed Discharge process which forms part of this Discharge Notice Agreement. The identifier is the same for all communications sent within the process. This allows withdrawal of all communications involved using a single reference. The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] author

The author of the Discharge Notice Agreement message.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="AUT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as an author participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "AUT".
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). Therefore, this specifies how the author recipient contributes to the context of the Discharge Notice Agreement and whether it may be propagated to descendent acts whose association allows such propagation. This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding)- the author replaces any author that has been conducted from any previous acts.
  • "P" (Propagating)- the author is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100030#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (AuthorChoice)

A link to the choice of author templates.

[1..1] [M] callBackContact
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="CALLBCK" }
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
[1..1] [M] contentId (II) { "NPFIT-100029#Role" }
[1..1] [M] participant (SocialServicesContactDetails)
[0..1] location
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="LOC" }
[1..1] [M] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
[1..1] [M] contentId (II) { "NPFIT-100023#Role" }
[1..1] participant (LocationChoice)
[0..1] pertinentInformation

This class is a pertinent information class used to link the Discharge Notice Agreement to the Additional Notes.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="PERT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this as pertinent information.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PERT".
[1..1] [M] seperatableInd (BL)
{ Fixed="false" }

Model Attribute Description

The HL7 attribute seperatableInd uses a Boolean (true or false) to indicate whether two pieces of information can be interpreted separately.

Implementation in XML Instance

  • The XML attribute seperatableInd is fixed to "false".
[1..1] pertinentAdditionalNotes (AdditionalNotes)

A link to the Additional Notes.

[1..1] [M] primaryInformationRecipient

The primary information recipient participation for the Discharge Notice Agreement message.

[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="PRCP" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a primary information recipient participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "PRCP".
[0..1] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }
Model Attribute Description

The HL7 attribute contextControlCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section are conducted across to the child section (also associated with the child section). Therefore, this specifies how the primary information recipient contributes to the context of the Discharge Notice Agreement and whether it may be propagated to descendent acts whose association allows such propagation. This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding) - the participation replaces any that has been conducted from any previous acts.
  • "P" (Propagating) - the participation is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100040#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifier.
[1..1] [M] participant (RecipientChoice)

A link to the choice of participant templates.

[1..1] [M] recordTarget
The patient whose record is the target of the Discharge Notice Agreement which is being accepted.
[1..1] [M] typeCode (CS { CNE: ParticipationType } )
{ Fixed="RCT" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe this class as a record target participation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "RCT".
[0..1] contextControlCode (CS { CNE: ContextControl } )
{ Fixed="OP" }

Model Attribute Description

The HL7 attribute contextConductionCode uses a set of codes from the HL7 vocabulary ContextControl to determine whether participations associated with the parent section is conducted across to the child section (also associated with the child section). This set of codes also determine how these participations conduct.

The conduction can only take place if the contextConductionInd is set to "true".

The value of this attribute is fixed in the HL7 model to "OP":

  • "O" (Overriding)- the record target replaces any record target that has been conducted from any previous acts.
  • "P" (Propagating)- the record target is conducted to all child acts where the contextConductionInd is set to "true".

Implementation in XML Instance

  • The XML attribute contextControlCode shall contain the value "OP".
[1..1] [M] contentId (II) { "NPFIT-100021#Role" }

Model Attribute Description

The HL7 (NHS localisation) attribute contentId, when valued in an instance, provides a unique forward pointing identifier for the template which constrains the classes and attributes which follow, for NHS use.

The attribute is intended simply as a structural navigational aid and should not be relied upon as an indicator of semantic meaning. The contentId is populated at runtime with a value from the allowed list contained in the model.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element contentId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.16".
  • The XML attribute extension shall contain one of the allowed template artefact identifiers.
[1..1] [M] participant (Patient)

A link to the patient role templates.

[1..1] [M] reference

A pointer to a reference to the Discharge Notice Agreement being accepted.

[1..1] [M] typeCode (CS { CNE: ActRelationshipType } )
{ Fixed="REFR" }

Model Attribute Description

The HL7 attribute typeCode uses a code to describe a relationship where the target act is referred to by the source act

Implementation in XML Instance

  • The XML attribute typeCode is fixed to "REFR".
[1..1] [M] referredToReferredToNotification (ReferredToNotification)

A link to the referred to notification.

AuthorChoice
An abstract placeholder for the templates of an Author.
Used by: DischargeNoticeAgreement
[1..1] : Template2
Patient

An abstract placeholder for the templates of a Patient.

Used by: DischargeNoticeAgreement
[1..1] : Template3
RecipientChoice

An abstract placeholder for the templates of a Recipient.

Used by: DischargeNoticeAgreement
[1..1] : Template4
ReferredToNotification

A reference to the Discharge Notification that is being accepted.

Used by: DischargeNoticeAgreement
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="CACT" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as a control act.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "CACT".

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as a control act event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".

[1..1] [M] id (II)
Model Attribute Description

The HL7 attribute id uses an identifier to identify each unique instance of the control act under which the Discharge Notice CDA document and data section was sent.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry the identifier in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
AdditionalNotes

Additional notes for the Discharge Notice Agreement.

Used by: DischargeNoticeAgreement
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }
Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

  • The XML attribute classCode is fixed to "OBS".
[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

  • The XML attribute moodCode is fixed to "EVN".
[1..1] [M] code (CV { CNE:ObservationType } )
{ Fixed="AN" }
Model Attribute Description

The HL7 attribute code uses a code from the ObservationType vocabulary to describe this as a type of observation for additional notes, the detail of which is carried in the HL7 attribute value of this class.

Implementation in XML Instance

The Coded with Code System flavour of the Coded Value (CV) shall be used to carry this information in the XML element code as follows:

  • The XML attribute value shall contain the fixed value "AN" vocabulary.
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.275".
  • The XML attribute displayName shall contain the text associated with the code.
[1..1] [M] value (ST)
Model Attribute Description

The HL7 attribute value is used to carry the information about the content of the additional notes, this value is associated with the HL7 attribute code of this class.

Implementation in XML Instance
  • The XML attribute xsi:type shall contain the value "ST".
  • The XML element value shall contain the information.
LocationChoice
Used by: DischargeNoticeAgreement
[1..1] : Template7
SocialServicesContactDetails
Used by: DischargeNoticeAgreement
[1..1] : Template1